home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SLCancelJob.z / SLCancelJob
Encoding:
Text File  |  2002-10-03  |  5.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSLLLLCCCCaaaannnncccceeeellllJJJJoooobbbb((((3333))))                   IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo                    SSSSLLLLCCCCaaaannnncccceeeellllJJJJoooobbbb((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SLCancelJob - cancels a queued printer job
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssppppoooooooollll....hhhh>>>>
  13.  
  14.      iiiinnnntttt SSSSLLLLCCCCaaaannnncccceeeellllJJJJoooobbbb((((ccccoooonnnnsssstttt cccchhhhaaaarrrr ****jjjjoooobbbb____iiiidddd,,,, uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ssssppppoooooooolllleeeerrrr,,,,
  15.                      ccccoooonnnnsssstttt cccchhhhaaaarrrr ****pppprrrriiiinnnntttteeeerrrr))));;;;
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      _S_L_C_a_n_c_e_l_J_o_b cancels the printer job currently queued for printing. Any
  19.      job on the queue which is owned by the user may be canceled regardless of
  20.      whether that job was submitted using _l_i_b_s_p_o_o_l functions or spooling
  21.      system commands.
  22.  
  23.      _j_o_b__i_d         Specifies the ID of the job to be canceled. This ID is
  24.                     available in the _S_L_P_r_i_n_t_J_o_b structure _j_o_b__i_d field if the
  25.                     job was submitted to a System V spooling system using
  26.                     _l_i_b_s_p_o_o_l. The job ID can also be obtained by examining the
  27.                     queue for the desired printer. Unfortunately the BSD
  28.                     spooling system does not provide a job ID when a print job
  29.                     is submitted. To obtain a job ID under the BSD spooling
  30.                     system the print queue must be examined.
  31.  
  32.      _s_p_o_o_l_e_r        This parameter specifies the spooling system to use when
  33.                     cancelling the job.  The possible spoolers that may be
  34.                     specified are System V (SSSSLLLL____SSSSPPPPOOOOOOOOLLLLEEEERRRR____SSSSYYYYSSSSVVVV ) or BSD
  35.                     (SSSSLLLL____SSSSPPPPOOOOOOOOLLLLEEEERRRR____BBBBSSSSDDDD).  If the default spooling system is to be
  36.                     used, this parameter should be specified as
  37.                     SSSSLLLL____SSSSPPPPOOOOOOOOLLLLEEEERRRR____NNNNOOOONNNNEEEE. The _s_p_o_o_l_e_r parameter is provided so that
  38.                     the cancelling of jobs on different spooling systems does
  39.                     not require setting a new default spooling system before
  40.                     each call to _S_L_C_a_n_c_e_l_J_o_b. Note that specifying a spooling
  41.                     system to _S_L_C_a_n_c_e_l_J_o_b does not affect the setting of the
  42.                     default spooling system.
  43.  
  44.      _p_r_i_n_t_e_r        Specifies the printer on whose queue the job resides. If
  45.                     this parameter is NNNNUUUULLLLLLLL, the default printer is assumed.
  46.  
  47. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  48.      0 is returned if execution was successful. -1 is returned and _S_L_e_r_r_n_o is
  49.      set if an execution error has occurred.
  50.  
  51. EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
  52.      _S_L_C_a_n_c_e_l_J_o_b will fail under the following circumstances.
  53.  
  54.      SL_ERR_FIND_SPOOLER      An error occurred while attempting to determine
  55.                               the available printer spooling systems.
  56.  
  57.      SL_ERR_NO_SPOOLERS       There are no printer spooling systems available.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSLLLLCCCCaaaannnncccceeeellllJJJJoooobbbb((((3333))))                   IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo                    SSSSLLLLCCCCaaaannnncccceeeellllJJJJoooobbbb((((3333))))
  71.  
  72.  
  73.  
  74.      SL_ERR_SPOOLER_UNKNOWN   The spooling system specified is not available.
  75.  
  76.  
  77.      SL_ERR_SPOOLER_ERROR     A printer spooling system error has occurred.
  78.  
  79.      SL_ERR_NO_JOBID          The print job ID specified is either a NULL
  80.                               pointer, an empty string ("") or a string
  81.                               consisting entirely of whitespace.
  82.  
  83.      When canceling a print job under the BSD spooling system, _S_L_C_a_n_c_e_l_J_o_b
  84.      will also fail under the following circumstances.
  85.  
  86.      SL_ERR_BAD_PRINTER_NAME  The printer name specified is either an empty
  87.                               string (""), or a string consisting entirely of
  88.                               whitespace.
  89.  
  90. NNNNOOOOTTTTEEEESSSS
  91.      1.   No confirmation that the job was found and canceled is provided.
  92.  
  93.      2.   Under System V spooling the _p_r_i_n_t_e_r parameter is ignored and can be
  94.           set to NNNNUUUULLLLLLLL. This is because the printer for the job is determined
  95.           from the job ID.
  96.  
  97. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  98.      SLSubmitJob(3), SLGetQueue(3), SLPerror(3), libspool(3), cancel(1)
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.